package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.EmpRewardPunishAddDTO;
import org.jsola.hr.dto.EmpRewardPunishUpdateDTO;
import org.jsola.hr.query.EmpRewardPunishQuery;
import org.jsola.hr.vo.EmpRewardPunishListVO;
import org.jsola.hr.vo.EmpRewardPunishVO;

import java.util.List;

/**
 * 员工奖惩记录
 *
 * @author zhr
 */
@Api(tags = "hr-员工奖惩记录")
public interface IEmpRewardPunishControllerAPI {

    /**
     * 新增员工奖惩记录
     * @param empRewardPunishAddDTO 员工奖惩记录新增实体
     * @return 员工奖惩记录展示对象
     */
    @ApiOperation(value = "新增员工奖惩记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empRewardPunishAddDTO", dataType = "EmpRewardPunishAddDTO", value = "新增员工奖惩记录", paramType = "body")
    })
    Result<EmpRewardPunishVO> save(EmpRewardPunishAddDTO empRewardPunishAddDTO);


    /**
     * 修改员工奖惩记录
     * @param empRewardPunishUpdateDTO 员工奖惩记录
     * @return 更新数量
     */
    @ApiOperation(value = "修改员工奖惩记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empRewardPunishUpdateDTO", dataType = "EmpRewardPunishUpdateDTO", value = "修改员工奖惩记录", paramType = "body")
    })
    Result<Integer> update(EmpRewardPunishUpdateDTO empRewardPunishUpdateDTO);




    /**
     * 删除单个员工奖惩记录，彻底删除
     * @param empRewardPunishId 员工奖惩记录id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个员工奖惩记录，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empRewardPunishId", dataType = "String", value = "员工奖惩记录id", paramType = "path")
    })
    Result<Integer> delete(String empRewardPunishId);


    /**
     * 批量删除员工奖惩记录，彻底删除
     * @param empRewardPunishIds 员工奖惩记录id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除员工奖惩记录，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empRewardPunishIds", dataType = "String[]", value = "员工奖惩记录id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] empRewardPunishIds);


    /**
     * 根据员工奖惩记录id查询员工奖惩记录详情
     * @param empRewardPunishId 员工奖惩记录id
     * @return 员工奖惩记录详情
     */
    @ApiOperation(value="根据员工奖惩记录id查询员工奖惩记录详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empRewardPunishId", dataType = "String", value = "员工奖惩记录id", paramType = "path")
    })
    Result<EmpRewardPunishVO> findById(String empRewardPunishId);


    /**
     * 查询员工奖惩记录
     * @param empRewardPunishQuery 员工奖惩记录查询参数
     * @return page
     */
    @ApiOperation(value="查询员工奖惩记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empRewardPunishQuery", dataType = "EmpRewardPunishQuery", value = "员工奖惩记录查询参数", paramType = "query")
    })
    Result<List<EmpRewardPunishListVO>> listAll(EmpRewardPunishQuery empRewardPunishQuery);


     /**
     * 分页查询员工奖惩记录
     * @param empRewardPunishQuery 员工奖惩记录查询参数
     * @return page
     */
    @ApiOperation(value="分页查询员工奖惩记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empRewardPunishQuery", dataType = "EmpRewardPunishQuery", value = "员工奖惩记录查询参数", paramType = "query")
    })
    Result<Page<EmpRewardPunishListVO>> page(EmpRewardPunishQuery empRewardPunishQuery);


}

